feat(component): Create new component for feature information in quick start guides by inventarSarah · Pull Request #16855 · getsentry/sentry-docs

inventarSarah · 2026-03-10T10:42:31Z

DESCRIBE YOUR PR

Background:
In our quick start guides, we have two Expandables that explain Sentry features:

"Do you want to learn more about these features?"
"Need help locating the captured errors in your Sentry project?"

I created these as PlatformIncludes, which led to:

inconsistency because listed features didn't always match the actual onboarding options
multiple files containing the same content
updating feature descriptions or adding a new feature required editing multiple files

Changes:
Created a new component that

centralizes feature descriptions in one file
supports "learn more" and "find in Sentry" content types
works across languages and platforms (it is not JS-specific)
makes it easier to add new features or update descriptions/links etc

I updated all the quick start guides to use the new include & component and removed the old PlatformInclude files.

closes: #16320

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

Urgent deadline (GA date, etc.):
Other deadline:
None: Not urgent, can wait up to 1 week+

SLA

Teamwork makes the dream work, so please add a reviewer to your PRs.
Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

Checked Vercel preview for correctness, including links
PR was reviewed and approved by any necessary SMEs (subject matter experts)
PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Sentry Docs contributor guide

…ick-start/clean-up-includes

vercel · 2026-03-10T10:42:36Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
sentry-docs	Ready	Preview, Comment	Mar 17, 2026 7:03am

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
develop-docs	Ignored	Preview	Mar 17, 2026 7:03am

…ick-start/clean-up-includes

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Autofix Details

Bugbot Autofix prepared a fix for the issue found in the latest run.

✅ Fixed: Wrong type prop shows descriptions instead of navigation
- Updated the Bun/Cloudflare/Deno/WASM PlatformSection to use type="findInSentry" so it now renders navigation instructions like the other sections.

Or push these changes by commenting:

@cursor push 9100a8fda8

Preview (9100a8fda8)

diff --git a/includes/quick-start-locate-data-expandable.mdx b/includes/quick-start-locate-data-expandable.mdx
--- a/includes/quick-start-locate-data-expandable.mdx
+++ b/includes/quick-start-locate-data-expandable.mdx
@@ -37,7 +37,7 @@
 
 <PlatformSection supported={["javascript.bun", "javascript.cloudflare", "javascript.deno", "javascript.wasm"]}>
 
-<FeatureInfo features={["issues", "logs", "tracing"]} type="learnMore" />
+<FeatureInfo features={["issues", "logs", "tracing"]} type="findInSentry" />
 
 </ PlatformSection>

_{This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.}

…ick-start/clean-up-includes

…try/sentry-docs into smi/quick-start/clean-up-includes

chargome

Thanks for simplifying! Generally this would be easier to review if you split it up a bit, but we can keep as is. Left some comments 🚀

chargome · 2026-03-11T12:02:50Z

+type FeatureKey =
+  | 'issues'
+  | 'tracing'
+  | 'sessionReplay'
+  | 'logs'
+  | 'profiling'
+  | 'userFeedback';


Added "Metrics" to the component including the needed content

chargome · 2026-03-13T12:20:13Z

+  type="learnMore"
+/>
+
+</ PlatformSection>


nit: Doesn't the formatter require </PlatformSection>? 🤔

🤔nothing complained to me about the spaces. Thanks for pointing this out -- removed the spaces

chargome · 2026-03-13T12:21:20Z

 />

-<PlatformContent includePath="getting-started-features-expandable" />
+<Include name="quick-start-features-expandable" />


Suggested change

<Include name="quick-start-features-expandable" />

<Include name="quick-start-features-expandable-cloudflare-frameworks" />

I might be wrong here, would this add frontend only features?

This gets the default Cloudflare version of the include, which contains the same features as Hono on Cloudflare.

chargome · 2026-03-13T12:23:30Z

+<FeatureInfo
+  features={[
+    "issues",
+    "logs",
+    "sessionReplay",
+    "tracing",
+    "profiling",
+    "userFeedback",
+  ]}


m: I think that cursor is right here with the order of features, tracing should be after issues

Updated the order accordingly.

I would then also update the order of the onboarding/feature options (in a separate issue) because there we always have Issues > Logs > session Replay > Tracing > Profiling > User Feedback
What do you think?

chargome · 2026-03-13T12:26:46Z

+        </ExternalLink>{' '}
+        page and select a trace to reveal more information about each span, its duration,
+        and any errors. For an interactive UI walkthrough, click{' '}
+        <a href="/product/sentry-basics/distributed-tracing/generate-first-error/#ui-walkthrough">


l: Use if possible

I tried to use but ran into server/client component issues that I couldn't resolve.
Happy to revisit this, but I need dev support 🙏

…ick-start/clean-up-includes

cursor

Cursor Bugbot has reviewed your changes and found 2 potential issues.

Autofix Details

Bugbot Autofix prepared fixes for both issues found in the latest run.

✅ Fixed: Profiling external link URL likely broken
- Updated the profiling find-in-Sentry link to the orgredirect URL pattern used by existing profiling documentation.
✅ Fixed: Locate-data content changes from ordered to unordered list
- FeatureInfo now renders find-in-Sentry content in an ordered list while keeping learn-more content unordered.

Or push these changes by commenting:

@cursor push 4d82d94864

Preview (4d82d94864)

diff --git a/src/components/featureInfo.tsx b/src/components/featureInfo.tsx
--- a/src/components/featureInfo.tsx
+++ b/src/components/featureInfo.tsx
@@ -102,7 +102,7 @@
     findInSentry: (
       <Fragment>
         Open the{' '}
-        <ExternalLink href="https://sentry.io/profiling">
+        <ExternalLink href="https://sentry.io/orgredirect/organizations/:orgslug/profiling">
           <strong>Profiles</strong>
         </ExternalLink>{' '}
         page, select a transaction, and then a profile ID to view its flame graph. For
@@ -158,8 +158,10 @@
  * @param type - learnMore shows feature descriptions, findInSentry shows navigation help
  */
 export function FeatureInfo({features, type}: FeatureInfoProps) {
+  const ListTag = type === 'findInSentry' ? 'ol' : 'ul';
+
   return (
-    <ul>
+    <ListTag>
       {features.map(key => {
         const feature = FEATURE_DATA[key];
 
@@ -176,6 +178,6 @@
 
         return <li key={key}>{feature.findInSentry}</li>;
       })}
-    </ul>
+    </ListTag>
   );
 }

_{This Bugbot Autofix run was free. To enable autofix for future PRs, go to the Cursor dashboard.}

…try/sentry-docs into smi/quick-start/clean-up-includes

chargome

LGTM but please check the failing 404 linter too

cursor

Cursor Bugbot has reviewed your changes and found 2 potential issues.

^{Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

cursor · 2026-03-17T07:00:51Z

+  | 'logs'
+  | 'profiling'
+  | 'userFeedback'
+  | 'metrics';


Unused metrics feature defined but never referenced

Low Severity

The metrics key is defined in the FeatureKey type and has a full data entry in FEATURE_DATA, but it's never referenced in any of the four new include files (quick-start-features-expandable.mdx, quick-start-locate-data-expandable.mdx, and their cloudflare-frameworks variants). This is dead code that adds maintenance burden without being used anywhere in the codebase.

Additional Locations (1)

src/components/featureInfo.tsx#L129-L145

cursor · 2026-03-17T07:00:51Z

-  visualize log data to understand what's happening in your applications.  
-
-</Expandable>
+<Include name="quick-start-features-expandable" />


Orphaned passthrough files no longer referenced anywhere

Low Severity

The _default.mdx file in getting-started-features-expandable and javascript.mdx in getting-started-verify-locate-data were converted to passthroughs but are no longer referenced by any file. All callers were migrated to use <Include> directly, so these platform-include files are now dead code that could be deleted along with their parent directories.

Additional Locations (1)

platform-includes/getting-started-verify-locate-data/javascript.mdx#L1-L2

…k start guides (#16855)  ## DESCRIBE YOUR PR **Background**: In our quick start guides, we have two Expandables that explain Sentry features: - "Do you want to learn more about these features?" - "Need help locating the captured errors in your Sentry project?" I created these as PlatformIncludes, which led to: - inconsistency because listed features didn't always match the actual onboarding options - multiple files containing the same content - updating feature descriptions or adding a new feature required editing multiple files **Changes:** Created a new component that - centralizes feature descriptions in one file - supports "learn more" and "find in Sentry" content types - works across languages and platforms (it is not JS-specific) - makes it easier to add new features or update descriptions/links etc I updated all the quick start guides to use the new include & component and removed the old PlatformInclude files. closes: #16320 ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.):  - [ ] Other deadline:  - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) ## LEGAL BOILERPLATE  Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms. ## EXTRA RESOURCES - [Sentry Docs contributor guide](https://docs.sentry.io/contributing/) --------- Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>

inventarSarah added 4 commits March 10, 2026 11:11

update feature includes in JS quick start guides

f64edb4

update links

68c4e2a

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/qu…

da03e7b

…ick-start/clean-up-includes

remove test formatting

34ec7b0

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/qu…

e09199c

…ick-start/clean-up-includes

vercel bot had a problem deploying to Preview – sentry-docs March 10, 2026 10:49 Failure

vercel bot had a problem deploying to Preview – develop-docs March 10, 2026 10:49 Failure

fix import

b288419

vercel bot had a problem deploying to Preview – sentry-docs March 10, 2026 11:01 Failure

vercel bot had a problem deploying to Preview – develop-docs March 10, 2026 11:01 Failure

inventarSarah and others added 4 commits March 10, 2026 13:53

linter fixes

ef42b21

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/qu…

0b2aadc

…ick-start/clean-up-includes

component fix

bab0dc4

[getsentry/action-github-commit] Auto commit

76ca9a3

vercel bot deployed to Preview – develop-docs March 10, 2026 14:02 View deployment

vercel bot deployed to Preview – sentry-docs March 10, 2026 14:05 View deployment

Merge branch 'master' into smi/quick-start/clean-up-includes

0dcffb0

vercel bot deployed to Preview – develop-docs March 11, 2026 08:31 View deployment

vercel bot deployed to Preview – sentry-docs March 11, 2026 08:34 View deployment

inventarSarah marked this pull request as ready for review March 11, 2026 09:28

sentry bot reviewed Mar 11, 2026

View reviewed changes

Comment thread includes/quick-start-locate-data-expandable.mdx Outdated

cursor bot reviewed Mar 11, 2026

View reviewed changes

Comment thread includes/quick-start-locate-data-expandable.mdx Outdated

inventarSarah added 3 commits March 11, 2026 11:08

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/qu…

8130a62

…ick-start/clean-up-includes

PR feedback

7e3f9a6

Merge branch 'smi/quick-start/clean-up-includes' of github.com:getsen…

406626c

…try/sentry-docs into smi/quick-start/clean-up-includes

sentry bot reviewed Mar 11, 2026

View reviewed changes

Comment thread includes/quick-start-features-expandable.mdx Outdated

cursor bot reviewed Mar 11, 2026

View reviewed changes

Comment thread includes/quick-start-features-expandable.mdx

vercel bot deployed to Preview – develop-docs March 11, 2026 10:16 View deployment

vercel bot deployed to Preview – sentry-docs March 11, 2026 10:21 View deployment

inventarSarah requested a review from chargome March 11, 2026 10:31

chargome reviewed Mar 13, 2026

View reviewed changes

inventarSarah and others added 4 commits March 16, 2026 10:13

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/qu…

09e08ac

…ick-start/clean-up-includes

PR review feedback

0c8ae18

update feature order

0e704a9

[getsentry/action-github-commit] Auto commit

5b72cf8

vercel bot deployed to Preview – develop-docs March 16, 2026 10:33 View deployment

cursor bot reviewed Mar 16, 2026

View reviewed changes

Comment thread src/components/featureInfo.tsx Outdated

Comment thread src/components/featureInfo.tsx

vercel bot deployed to Preview – sentry-docs March 16, 2026 10:36 View deployment

inventarSarah added 2 commits March 16, 2026 13:29

update external links

c3e4772

Merge branch 'smi/quick-start/clean-up-includes' of github.com:getsen…

7633886

…try/sentry-docs into smi/quick-start/clean-up-includes

vercel bot deployed to Preview – develop-docs March 16, 2026 12:36 View deployment

vercel bot deployed to Preview – sentry-docs March 16, 2026 12:39 View deployment

chargome approved these changes Mar 16, 2026

View reviewed changes

Merge branch 'master' into smi/quick-start/clean-up-includes

3e7cd75

vercel bot deployed to Preview – develop-docs March 17, 2026 06:33 View deployment

cursor bot reviewed Mar 17, 2026

View reviewed changes

Comment thread docs/platforms/javascript/guides/remix/index.mdx

vercel bot deployed to Preview – sentry-docs March 17, 2026 06:37 View deployment

update Remix include

0919d34

cursor bot reviewed Mar 17, 2026

View reviewed changes

Comment thread platform-includes/getting-started-complete/javascript.mdx

vercel bot deployed to Preview – sentry-docs March 17, 2026 06:52 View deployment

update platfomContent to Include

f6a1a76

cursor bot reviewed Mar 17, 2026

View reviewed changes

vercel bot deployed to Preview – sentry-docs March 17, 2026 07:03 View deployment

inventarSarah merged commit 4d92306 into master Mar 17, 2026
20 checks passed

inventarSarah deleted the smi/quick-start/clean-up-includes branch March 17, 2026 07:30

github-actions bot locked and limited conversation to collaborators Apr 2, 2026

	<Include name="quick-start-features-expandable" />
	<Include name="quick-start-features-expandable-cloudflare-frameworks" />

Uh oh!

Conversation

inventarSarah commented Mar 10, 2026

DESCRIBE YOUR PR

IS YOUR CHANGE URGENT?

SLA

PRE-MERGE CHECKLIST

LEGAL BOILERPLATE

EXTRA RESOURCES

Uh oh!

vercel bot commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chargome left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

chargome left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Mar 17, 2026

Choose a reason for hiding this comment

Unused metrics feature defined but never referenced

Uh oh!

cursor bot Mar 17, 2026

Choose a reason for hiding this comment

Orphaned passthrough files no longer referenced anywhere

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vercel bot commented Mar 10, 2026 •

edited

Loading

cursor bot left a comment •

edited

Loading

cursor bot left a comment •

edited

Loading

Unused `metrics` feature defined but never referenced